home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkHelpPane.z / VkHelpPane
Encoding:
Text File  |  2002-10-03  |  6.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))                                                  VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkHelpPane - A menu pane that interfaces to the ViewKit help system
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkSubMenu : VkMenu : VkMenuItem : VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkHelpPane.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkHelpPane(const char *name,
  20.                       VkMenuDesc *desc = NULL,
  21.                       XtPointer defaultClientData = NULL);
  22.            VkHelpPane(Widget parent,
  23.                       const char *name,
  24.                       VkMenuDesc *desc = NULL,
  25.                       XtPointer defaultClientData = NULL);
  26.            virtual void ~VkHelpPane(void);
  27.  
  28.  
  29. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  30.           This class is a ready-made menu pane that provides an interface to
  31.           the standard help protocol supported by all ViewKit applications.
  32.           This menu pane can be added to other menus or menu panes as needed.
  33.           All interactions with the help system are handled automatically.
  34.  
  35.           For example, the following code segment creates a popup menu and
  36.           adds a cascading help pane to the popup:
  37.  
  38.  
  39.            // ...
  40.  
  41.            VkPopupMenu *actionsPopup = new VkPopupMenu();
  42.  
  43.            actionsPopup->addSubmenu(new VkHelpPane("helpMenu"));
  44.            actionsPopup->attach(parent);
  45.  
  46.  
  47. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  48.    VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee(((())))
  49.            VkHelpPane(const char *name,
  50.                       VkMenuDesc *desc = NULL,
  51.                       XtPointer defaultClientData = NULL);
  52.            VkHelpPane(Widget parent,
  53.                       const char *name,
  54.                       VkMenuDesc *desc = NULL,
  55.                       XtPointer defaultClientData = NULL);
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))                                                  VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           Initialize a VkHelpPane object. If a menu description is provided,
  75.           the specified items will be added to the top of the help menu before
  76.           the standard items are added.
  77.  
  78.    ~~~~VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee(((())))
  79.            virtual void ~VkHelpPane(void);
  80.  
  81.  
  82.           Free all memory associated with a VkHelpPane object.
  83.  
  84. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  85.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkSSSSuuuubbbbMMMMeeeennnnuuuu
  86.           widgetDestroyed(), build(), menuType(), menuParent(), VkSubMenu(),
  87.           VkSubMenu(), ~VkSubMenu(), pulldown(), _pulldown
  88.  
  89.  
  90.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuu
  91.           isContainer(), findParent(), addAction(), addActionWidget(),
  92.           addConfirmFirstAction(), addSeparator(), addLabel(), addToggle(),
  93.           addToggle(), add(), addSubmenu(), addRadioSubmenu(),
  94.           registerSubmenu(), findNamedItem(), removeItem(), activateItem(),
  95.           deactivateItem(), replace(), getItemPosition(), getItemPosition(),
  96.           getItemPosition(), operator[](), numItems(), _contents, _nItems,
  97.           _maxItems,
  98.  
  99.  
  100.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuIIIItttteeeemmmm
  101.           show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
  102.           deactivate(), remove(), show(), _position, _isBuilt, _sensitive,
  103.           _parentMenu, _label, _isHidden, _unmanagedWidgets,
  104.           _numUnmanagedWidgets,
  105.  
  106.  
  107.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  108.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  109.           setDefaultResources(), getResources(), manage(), unmanage(),
  110.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  111.  
  112.  
  113.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  114.           callCallbacks(), addCallback(), removeCallback(),
  115.           removeAllCallbacks()
  116.  
  117.  
  118. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  119.      VkApp, VkDialogManager, VkMenu
  120.  
  121. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  122.      VkHelpPane
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))                                                  VVVVkkkkHHHHeeeellllppppPPPPaaaannnneeee((((3333xxxx))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      VkSubMenu, VkMenu, VkMenuItem, VkComponent, VkApp, VkDialogManager
  142.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  143.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  144.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  145.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.